/**
 * Copyright (C) 2005-2009 Alfresco Software Limited.
 *
 * This file is part of the Spring Surf Extension project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.extensions.webscripts.connector;

import org.springframework.extensions.surf.exception.CredentialVaultProviderException;

/**
 * Interface for a Credential Vault provider
 * 
 * @author muzquiano
 */
public interface CredentialVaultProvider
{
    /**
     * Provide a credential vault for the given ID
     * 
     * @param id    Credential vault ID
     * 
     * @return a new Credential Vault implementation
     * 
     * @throws CredentialVaultProviderException
     */
    public CredentialVault provide(String id) throws CredentialVaultProviderException;
    
    /**
     * Provide a key for this Credential Vault for caching purposes
     * 
     * @param id        Credential vault ID
     * @param userId    User ID
     * 
     * @return key as appropriate for this Credential Vault implementation
     */
    public String generateKey(String id, String userId);
}